-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
CLN: add deprecation warning to set_printoptions, reset_printoptions #2393
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I imagine a lot of people are finding out what options are available by looking at the docstring of |
You're right, I did/do too. Could also create a or both. what do you think is best? |
The doctsrings for all the options API functions now include a list of options and their In [3]: ?pd.set_option
Type: CallableDyanmicDoc
String Form:<pandas.core.config.CallableDyanmicDoc object at 0x3439b90>
File: /home/user1/src/pandas/pandas/core/config.py
Definition: pd.set_option(self, *args, **kwds)
Docstring:
set_option(pat,value) - Sets the value of the specified option
Available options:
print_config.[colheader_justify, column_space, date_dayfirst, date_yearfirst,
digits, encoding, float_format, max_columns, max_colwidth,
max_rows, multi_sparse, notebook_repr_html, pprint_nest_depth,
precision]
Parameters
----------
pat - str/regexp which should match a single option.
Returns
-------
None
Raises
------
KeyError if no such option exists
print_config.colheader_justify: No description available.
print_config.column_space: No description available.
print_config.date_dayfirst:
: boolean
When True, prints and parses dates with the day first, eg 20/01/2005
print_config.date_yearfirst:
: boolean
When True, prints and parses dates with the year first, eg 2005/01/20
print_config.digits: No description available.
print_config.encoding:
: str/unicode
Defaults to the detected encoding of the console.
Specifies the encoding to be used for strings returned by to_string,
these are generally strings meant to be displayed on the console.
print_config.float_format: No description available.
print_config.max_columns:
: int
max_rows and max_columns are used in __repr__() methods to decide if
to_string() or info() is used to render an object to a string.
Either one, or both can be set to 0 (experimental). Pandas will figure
out how big the terminal is and will not display more rows or/and
columns that can fit on it.
print_config.max_colwidth: No description available.
print_config.max_rows:
: int
print_config.multi_sparse:
: boolean
Default True, "sparsify" MultiIndex display (don't display repeated
elements in outer levels within groups)
print_config.notebook_repr_html:
: boolean
When True (default), IPython notebook will use html representation for
pandas objects (if it is available).
print_config.pprint_nest_depth:
: int
<...> |
changed to print.X, every little bit counts. |
Merged this, thanks. One downside I can think of immediately is the lack of tab completion. With set_printoptions, you can tab-complete all of the options in IPython, like the untidy |
Agreed. Obiously it would be cleaner to have a single interface though. |
Is there a discussion somewhere of the benefits of the lack of kwargs in |
Tab-completion was addressed with overall, I think we got it right. |
Ok thanks. And just to be sure, the recommended tab-complete way of doing
is now
right? |
afict, wes decided to keep |
Well there is a deprecation warning there. I was thinking it'd be better to remove |
No description provided.